<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>Class bmqt::UriBuilder</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javaScript" src="search/search.js"></script>
<link href="bdedox.css" rel="stylesheet" type="text/css"/>
    <style>
      div.hanging {
        padding-left: 0.75in;
        text-indent: -0.50in;
      }
      div.unhanging {
        text-indent:     0in;
      }
      a.glossary {
        font-weight: bold;
        font-style: italic;
      }
    </style>
</head>
<!--
<body onload='searchBox.OnSelectItem(0);'>
-->
<body>

<table border=2 cellspacing=0 cellpadding=0 align=center>
<tr>
 <td valign=top align=center>
 <p align=center><b><i>Quick Links:</i></b></p>
 </td>
 <td valign=top align=center>
 <p align=center>
<a class="qindex" href="group__bmqa.html" target="_blank">bmqa</a> | <a class="qindex" href="group__bmqpi.html" target="_blank">bmqpi</a> | <a class="qindex" href="group__bmqt.html" target="_blank">bmqt</a>
 </td>
 </tr>
 </table>

  </div>
<!-- Generated by Doxygen 1.7.1 -->
<div class="navigation" id="top">
  <div class="tabs">
    <ul class="tablist">
      <li><a href="components.html"><span>Main&nbsp;Page</span></a></li>
      <li><a href="components.html"><span>Components</span></a></li>
      <li><a href="namespaces.html"><span>Namespaces</span></a></li>
      <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
      <li><a href="files.html"><span>Files</span></a></li>
    </ul>
  </div>
  <div class="tabs2">
    <ul class="tablist">
      <li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
      <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
    </ul>
  </div>
  <div class="navpath">
    <ul>
      <li><a class="el" href="namespacebmqt.html">bmqt</a>      </li>
      <li><a class="el" href="classbmqt_1_1UriBuilder.html">bmqt::UriBuilder</a>      </li>
    </ul>
  </div>
</div>
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a>  </div>
  <div class="headertitle">
<h1>bmqt::UriBuilder Class Reference</h1>  </div>
</div>
<div class="contents">
<!-- doxytag: class="bmqt::UriBuilder" -->
<p><code>#include &lt;<a class="el" href="bmqt__uri_8h_source.html">bmqt_uri.h</a>&gt;</code></p>

<p><a href="classbmqt_1_1UriBuilder-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbmqt_1_1UriBuilder.html#a0171378dc3a60e66d1506eab5bd86966">UriBuilder</a> (bslma::Allocator *allocator=0)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbmqt_1_1UriBuilder.html#ac1c6d5490a006806b7ade98843b1b2a5">UriBuilder</a> (const <a class="el" href="classbmqt_1_1Uri.html">bmqt::Uri</a> &amp;uri, bslma::Allocator *allocator=0)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classbmqt_1_1UriBuilder.html">UriBuilder</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbmqt_1_1UriBuilder.html#a3a63403537cfd406b54f7126a826bce3">setDomain</a> (const bslstl::StringRef &amp;value)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classbmqt_1_1UriBuilder.html">UriBuilder</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbmqt_1_1UriBuilder.html#aab8135150445a02c52a131c68691fcc7">setTier</a> (const bslstl::StringRef &amp;value)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classbmqt_1_1UriBuilder.html">UriBuilder</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbmqt_1_1UriBuilder.html#a9598116e542b1e96deea2ac9d0883d24">setQualifiedDomain</a> (const bslstl::StringRef &amp;value)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classbmqt_1_1UriBuilder.html">UriBuilder</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbmqt_1_1UriBuilder.html#adbf5f1ed33afc47c4a7b6fd3c9500567">setQueue</a> (const bslstl::StringRef &amp;value)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classbmqt_1_1UriBuilder.html">UriBuilder</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbmqt_1_1UriBuilder.html#a069016e1fb9955f7eeec82148052b45f">setId</a> (const bslstl::StringRef &amp;value)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbmqt_1_1UriBuilder.html#abcc5c5e695a0ecd819a42221ef155192">reset</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbmqt_1_1UriBuilder.html#ad420e9c9aa7d7d868154b8db69c5e141">uri</a> (<a class="el" href="classbmqt_1_1Uri.html">Uri</a> *result, bsl::string *errorDescription=0) const </td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>This component implements a mechanism, <code><a class="el" href="classbmqt_1_1UriBuilder.html">bmqt::UriBuilder</a></code>, that can be used for creating queue URI for BMQ.</p>
<p>See <a class="el" href="group__bmqt__uri.html">Component bmqt_uri</a> </p>
<hr/><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="a0171378dc3a60e66d1506eab5bd86966"></a><!-- doxytag: member="bmqt::UriBuilder::UriBuilder" ref="a0171378dc3a60e66d1506eab5bd86966" args="(bslma::Allocator *allocator=0)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bmqt::UriBuilder::UriBuilder </td>
          <td>(</td>
          <td class="paramtype">bslma::Allocator *&nbsp;</td>
          <td class="paramname"> <em>allocator</em> = <code>0</code></td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [explicit]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Create a new <a class="el" href="classbmqt_1_1UriBuilder.html">UriBuilder</a> using the optionally specified <code>allocator</code>. </p>

</div>
</div>
<a class="anchor" id="ac1c6d5490a006806b7ade98843b1b2a5"></a><!-- doxytag: member="bmqt::UriBuilder::UriBuilder" ref="ac1c6d5490a006806b7ade98843b1b2a5" args="(const bmqt::Uri &amp;uri, bslma::Allocator *allocator=0)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bmqt::UriBuilder::UriBuilder </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="classbmqt_1_1Uri.html">bmqt::Uri</a> &amp;&nbsp;</td>
          <td class="paramname"> <em>uri</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">bslma::Allocator *&nbsp;</td>
          <td class="paramname"> <em>allocator</em> = <code>0</code></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td><code> [explicit]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Create a new <a class="el" href="classbmqt_1_1UriBuilder.html">UriBuilder</a> initialized with the specified <code>uri</code> and using the optionally specified <code>allocator</code>. </p>

</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a3a63403537cfd406b54f7126a826bce3"></a><!-- doxytag: member="bmqt::UriBuilder::setDomain" ref="a3a63403537cfd406b54f7126a826bce3" args="(const bslstl::StringRef &amp;value)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classbmqt_1_1UriBuilder.html">UriBuilder</a>&amp; bmqt::UriBuilder::setDomain </td>
          <td>(</td>
          <td class="paramtype">const bslstl::StringRef &amp;&nbsp;</td>
          <td class="paramname"> <em>value</em></td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

</div>
</div>
<a class="anchor" id="aab8135150445a02c52a131c68691fcc7"></a><!-- doxytag: member="bmqt::UriBuilder::setTier" ref="aab8135150445a02c52a131c68691fcc7" args="(const bslstl::StringRef &amp;value)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classbmqt_1_1UriBuilder.html">UriBuilder</a>&amp; bmqt::UriBuilder::setTier </td>
          <td>(</td>
          <td class="paramtype">const bslstl::StringRef &amp;&nbsp;</td>
          <td class="paramname"> <em>value</em></td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

</div>
</div>
<a class="anchor" id="a9598116e542b1e96deea2ac9d0883d24"></a><!-- doxytag: member="bmqt::UriBuilder::setQualifiedDomain" ref="a9598116e542b1e96deea2ac9d0883d24" args="(const bslstl::StringRef &amp;value)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classbmqt_1_1UriBuilder.html">UriBuilder</a>&amp; bmqt::UriBuilder::setQualifiedDomain </td>
          <td>(</td>
          <td class="paramtype">const bslstl::StringRef &amp;&nbsp;</td>
          <td class="paramname"> <em>value</em></td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

</div>
</div>
<a class="anchor" id="adbf5f1ed33afc47c4a7b6fd3c9500567"></a><!-- doxytag: member="bmqt::UriBuilder::setQueue" ref="adbf5f1ed33afc47c4a7b6fd3c9500567" args="(const bslstl::StringRef &amp;value)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classbmqt_1_1UriBuilder.html">UriBuilder</a>&amp; bmqt::UriBuilder::setQueue </td>
          <td>(</td>
          <td class="paramtype">const bslstl::StringRef &amp;&nbsp;</td>
          <td class="paramname"> <em>value</em></td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

</div>
</div>
<a class="anchor" id="a069016e1fb9955f7eeec82148052b45f"></a><!-- doxytag: member="bmqt::UriBuilder::setId" ref="a069016e1fb9955f7eeec82148052b45f" args="(const bslstl::StringRef &amp;value)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classbmqt_1_1UriBuilder.html">UriBuilder</a>&amp; bmqt::UriBuilder::setId </td>
          <td>(</td>
          <td class="paramtype">const bslstl::StringRef &amp;&nbsp;</td>
          <td class="paramname"> <em>value</em></td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Set the corresponding field of the URI to the specified <code>value</code>. The behavior is undefined unless <code>value</code> remains valid until URI has been built by invoking <code><a class="el" href="classbmqt_1_1UriBuilder.html#ad420e9c9aa7d7d868154b8db69c5e141">uri()</a></code>. <code><a class="el" href="classbmqt_1_1UriBuilder.html#a3a63403537cfd406b54f7126a826bce3">setDomain()</a></code> and <code><a class="el" href="classbmqt_1_1UriBuilder.html#aab8135150445a02c52a131c68691fcc7">setTier()</a></code> should be preferred over <code><a class="el" href="classbmqt_1_1UriBuilder.html#a9598116e542b1e96deea2ac9d0883d24">setQualifiedDomain()</a></code> whenever possible. </p>

</div>
</div>
<a class="anchor" id="abcc5c5e695a0ecd819a42221ef155192"></a><!-- doxytag: member="bmqt::UriBuilder::reset" ref="abcc5c5e695a0ecd819a42221ef155192" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void bmqt::UriBuilder::reset </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Reset all fields of this builder. </p>

</div>
</div>
<a class="anchor" id="ad420e9c9aa7d7d868154b8db69c5e141"></a><!-- doxytag: member="bmqt::UriBuilder::uri" ref="ad420e9c9aa7d7d868154b8db69c5e141" args="(Uri *result, bsl::string *errorDescription=0) const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int bmqt::UriBuilder::uri </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="classbmqt_1_1Uri.html">Uri</a> *&nbsp;</td>
          <td class="paramname"> <em>result</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">bsl::string *&nbsp;</td>
          <td class="paramname"> <em>errorDescription</em> = <code>0</code></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td> const</td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Build and populate the specified <code>result</code> with the built URI, returning 0 on success, or return non-zero on error, populating the optionally specified <code>errorDescription</code> if provided. </p>

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="bmqt__uri_8h_source.html">bmqt_uri.h</a></li>
</ul>
</div>
<hr class="footer"/><address class="footer"><small>Generated on Thu Jun 15 2023 11:58:52 by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.1 </small></address>
</body>
</html>
